home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 23 / Amiga Format AFCD23 (Feb 1998, Issue 107).iso / -seriously_amiga- / shareware / programming / mui / mcc_datetext / docs / english / datetext_mcc.doc next >
Text File  |  1997-12-06  |  16KB  |  492 lines
  1.  
  2.                       Table of Contents
  3.  
  4.   Copyright                   - Copyright information
  5.   Distribution                - Copying conditions
  6.   Disclaimer                  - Legal Information
  7.   Trademark                   - Trademark information
  8.   Support/Updates             - How to get updates and support
  9.   Author                      - How to reach the author
  10.  
  11.   Description                 - What is DateText.mcc?
  12.   Requirements                - Requirements for using DateText.mcc
  13.  
  14.   Installation                - How to install DateText.mcc
  15.   Beta testers                - Installation information for beta testers
  16.  
  17.   Developer Info              - Information for developers
  18.  
  19.   History                     - Revision history of DateText.mcc
  20.   Todo                        - Todo list
  21.   Known problems              - List of known problems
  22.   Acknowledgments             - Acknowledgments
  23.   Please rate                 - Please rate DateText.mcc
  24.   Software                    - Software that uses DateText.mcc
  25.  
  26.  
  27.  
  28. Copyright
  29. ---------
  30.  
  31. This software and its documentation are copyright 1996-1997 by Kai Hofmann. All
  32. rights reserved!
  33.  
  34. - Permission for COMMERCIAL USE is only given by an extra available commercial
  35.   license that must be validated!
  36.   Contact me directly for this license, because it will be individually handed
  37.   out per your needs!
  38.  
  39. - Permission is hereby granted, without written agreement and without license,
  40.   to USE this software and its documentation for any NON-COMMERCIAL purpose,
  41.   provided that the above copyright notice and the following paragraph appear
  42.   in all copies of this software (Non-commercial includes Giftware!).
  43.  
  44.   Please send me a full version of your product at no cost including free
  45.   updates!
  46.   Extra money is welcome (For Bank Account see author - but *ONLY* send in DM
  47.   to this Bank Account!).
  48.  
  49.  
  50.  
  51. Distribution
  52. ------------
  53.  
  54. Permission is hereby granted, without written agreement and without license
  55. or royalty fees, to copy and distribute this software and its documentation
  56. for any purpose, provided that the above copyright notice and the following
  57. paragraphs appear in all copies of this software, to:
  58.  
  59. - All who will distribute this software for free!
  60. - All free accessible INTERNET servers!
  61. - All Aminet® sites
  62. - Fred Fish for his great Amiga-Software-Library
  63. - The German SAAR AG PD-Library
  64. - Angela Schmidt's Meeting Pearls serie
  65. - All others who do NOT take more than US$ 5.- for one disk that includes this
  66.   software!
  67.  
  68.  
  69.  
  70. IMPORTANT NOTE:
  71.  
  72. This package may not be included on any further Aminet CD-ROMs unless authors
  73. contributing their software to the CD-ROM, (without mentioning distribution
  74. "NoCD") are granted a copy of the CD *completely* *free* *of* *charge*.
  75.  
  76. The Meeting Pearls IV CD-ROM demonstrates that a Freebie policy is also
  77. possible with "very-low-budget" CD-ROMs (*), so Aminet should quickly
  78. re-establish the same Freebie policy it used up to Aminet CD 13.
  79.  
  80. (*) Suggested retail price for MP4 is DM 14,95/US$ 12/£ 8.95.
  81.  
  82.  
  83.  
  84. DISCLAIMER
  85. ----------
  86.  
  87. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  88. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  89. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  90. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  91. OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
  92. TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
  93. PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
  94. CORRECTION.
  95.  
  96. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
  97. ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  98. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  99. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO
  100. USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  101. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE
  102. OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR
  103. OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  104.  
  105. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  106. ENHANCEMENTS, OR MODIFICATIONS.
  107.  
  108.  
  109.  
  110. Trademark
  111. ---------
  112.  
  113. DateLib is a trademark of Kai Hofmann.
  114.  
  115. Amiga, AmigaDOS and Workbench are registered trademarks of Amiga International,
  116. Inc.
  117. Aminet is a registered trademark of Stefan Ossowskis Schatztruhe GmbH
  118. SAS/C is a registered trademark of SAS Institute Inc.
  119.  
  120. All other trademarked names used herein are used for the purposes of
  121. identification and for the benefit of the trademark holder. No infringement
  122. of trademarks is intended. Trademarks remain the property of the trademark
  123. holder.
  124.  
  125.  
  126.  
  127. Support/Updates
  128. ---------------
  129.  
  130. - Updates will be available via Aminet®
  131. - Support will be available via the authors email address and via
  132.   http://home.pages.de/~i07m/amiga/mui/DateText.html
  133.  
  134.  
  135.  
  136. Author
  137. ------
  138.  
  139. Kai Hofmann
  140. Arberger Heerstraße 92
  141. 28307 Bremen
  142. Germany
  143.  
  144. Phone: (+49)-(0)421/480780
  145. EMail: i07m@informatik.uni-bremen.de
  146.        i07m@zfn.uni-bremen.de
  147. IRC  : PowerStat@#AmigaGer
  148. WWW  : http://home.pages.de/~i07m/
  149.  
  150. Bank account : 1203 7503
  151. Account owner: Kai Hofmann
  152. Bank code    : 290 501 01
  153. Bank name    : Sparkasse in Bremen/Germany
  154.  
  155.  
  156.  
  157. Description
  158. -----------
  159.  
  160. DateText is a Custom Class of the Magic User Interface © by Stefan Stuntz.
  161. It's a subclass of text-class and date-class.
  162.  
  163. The idea of this class was born during developing my Gregor application.
  164.  
  165. MUI public custom class displaying a text gadget for date strings. The
  166. display format of the date string can be freely defined.
  167.  
  168. DateText.mcc features that are of interest for users:
  169. - Handles years from 8 to 8000
  170. - Supports the Gregorian calendar reform
  171. - Supports 21 languages
  172. - Can be dragged around
  173. - A week can begin with any weekday
  174. - Supports various string formats
  175.  
  176. DateText.mcc features of interest for developers:
  177. - Based on Date.mcc
  178. - Supports MUIM_Import and MUIM_Export
  179. - The date can be read as day/month/year format or as JD or MJD
  180. - The date range can be restricted
  181. - Method to set the current date
  182. - Methods for increasing and decreasing the date
  183. - Method to compare with another date object
  184.  
  185. The display format for a DateText object can be defined by the following
  186. formatting codes:
  187.  
  188. Syntax of Amiga compatible % commands:
  189.   %d - Day number with leading 0s
  190.   %e - Day number with leading spaces
  191.   %m - Month number with leading 0s
  192.   %h - Abbreviated month name
  193.   %b - Abbreviated month name
  194.   %B - Month name
  195.   %y - Year using two digits with leading 0s
  196.   %Y - Year using four digits with leading 0s
  197.   %j - Julian date
  198.   %w - Weekday number
  199.   %a - Abbreviated weekday name
  200.   %A - Weekday name
  201.   %U - Week number, taking Sunday as first day of week
  202.   %W - Week number, taking Monday as first day of week
  203.   %x - Same as "%m/%d/%y"
  204.   %D - Same as "%m/%d/%y"
  205.  
  206. Syntax of % commands:
  207.   %Ddf  - Day with leading 0s
  208.   %Ddv  - Day without leading 0s
  209.   %DDf  - Day within the year with leading 0s
  210.   %DDv  - Day within the year without leading 0s
  211.   %Dmf  - Month with leading 0s
  212.   %Dmv  - Month without leading 0s
  213.   %Dms  - Month string
  214.   %Dma  - Abbreviated month string
  215.   %Dy2f - 2-digit year with leading 0s
  216.   %Dy2v - 2-digit year without leading 0s
  217.   %Dy4f - 4-digit year with leading 0s
  218.   %Dy4v - 4-digit year without leading 0s
  219.   %Dys  - Scaliger year
  220.   %Dj   - JD date
  221.   %DJ   - MJD date
  222.   %Dwn  - Weekday number (1-7)
  223.   %Dws  - Weekday string
  224.   %Dwa  - Abbreviated weekday string
  225.   %DWf  - Weeknumber with leading 0s
  226.   %DWv  - Weeknumber without leading 0s
  227.   %DMf  - Age of the moon (0-30 ?) with leading 0s
  228.   %DMv  - Age of the moon (0-30 ?) without leading 0s
  229.  
  230.  
  231.  
  232. Requirements
  233. ------------
  234.  
  235. - MUI 3.1 (Version 12)
  236. - date.library
  237. - locale.library
  238.  
  239. - To use the Greek MCC-Install script you need the
  240.   "Greek Workbench" © AC Software
  241.  
  242. - To use the Russian MCC-Install script you need
  243.   "Rusifier" © Dmitry Mikhilov
  244.  
  245.  
  246.  
  247. Installation
  248. ------------
  249.  
  250. Only use the installer script!
  251. (The Installer must be in your system-path!)
  252.  
  253. If you use an Installer prior to V42 you should set the LANGUAGE Tooltype to
  254. your language. Installer V42 and better automatically use your current locale.
  255.  
  256.  
  257. Please note that the installer-script is very special, because:
  258.  
  259. - It features uninstallation
  260. - It is automated
  261. - It is very flexible
  262. - It is very intelligent (for an installer-script ;-)
  263. - It uses WrapGuide (if present) for the AmigaGuide®
  264.   documentation if running under a pre V39 system.
  265. - It can be reused by (hopefully) all other MUI custom classes, because the
  266.   authors of custom classes need to only change a few things:
  267.  
  268.   * The #copyright variable
  269.   * The #min_os_version and #min_os_revision variables
  270.   * The #min_mui_version and #min_mui_revision variables
  271.   * The #language_mcc and #language_mcc variables
  272.   * The P_CustomExists, P_CustomInstall and P_CustomUninstall procedures
  273.   * The 'APPNAME' tooltype within the MCC-Install icon.
  274.  
  275.  
  276.  
  277. Beta testers
  278. ------------
  279.  
  280. Version numbers of beta release will not change, so you must uninstall an
  281. earlier installed beta version before you can install a newer one!
  282.  
  283.  
  284.  
  285. Information for Developers
  286. --------------------------
  287.  
  288. There is no multiple inheritance for Boopsi/MUI for the moment, so we haven't
  289. any chance to create a real Date basis-class. But there is another way to have
  290. the same result (compatibility for all classes that are dealing with dates).
  291. The solution is called interface inheritance like it was done with IDL for
  292. CORBA.
  293. DateText.mcc inherits the interface from Date.mcc!
  294.  
  295.  
  296. Btw. it would be wise to use a
  297.  
  298.  SetAttrs(obj,
  299.             MUIA_Date_Year,  year,
  300.             MUIA_Date_Month, month,
  301.             MUIA_Date_Day,   day,
  302.           TAG_DONE
  303.          );
  304.  
  305. instead of single set()'s.
  306.  
  307.  
  308. - The following attributes are filtered out, so that they can't bring
  309.   a DateText object into trouble:
  310.   MUIA_Text_Contents, MUIA_Text_HiChar, MUIA_Text_SetVMax, MUIA_FillArea
  311.  
  312. - When MUIA_ObjectID is defined a DateText object will load/save the
  313.   following data during MUIM_Application_Load/MUIM_Application_Save
  314.   Day, Month, Year
  315.  
  316.  
  317.  
  318. History
  319. -------
  320.  
  321. 27.11.1997 -    First release on Aminet
  322.  
  323.  
  324.  
  325. Todo
  326. ----
  327.  
  328. - MUIV_Font_Date ?
  329.  
  330.  
  331. Known problems
  332. --------------
  333.  
  334. - I heard that using 'test' and then 'cancel' the test settings within the
  335.   MUI preference manager will not work as expected when in using your MUI
  336.   classes within Libs:MUI/ instead of MUI:Libs/MUI/ !!!
  337.  
  338. - Old versions of the program called 'PhoneCost' written by André Schenk
  339.   <schenkae@tick.informatik.uni-stuttgart.de> installed another
  340.   'date.library' into 'Libs:'.
  341.  
  342.  
  343.  
  344. Acknowledgments are going to the following people:
  345.  
  346. Rita Reichl         : for correcting my English and being my inspiration
  347.  
  348. James Cooper,
  349. Steve Krueger,
  350. Doug Walker         : For supporting SAS/C® after SAS suspends the support.
  351.  
  352. Stefan Stuntz       : for the Magic User Interface and for his support
  353. Klaus Melchior      : for the MUI custom class support
  354. Martin Huttenloher  : for MagicWB
  355. Udo Schuermann      : for WrapGuide
  356. Stefan Kost         : for ag2txt
  357. Jürgen Kohrmeyer    : for the rexxtricks.library
  358.  
  359. Eric Gerard         : for his great icons
  360.  
  361.  
  362.  
  363. Please rate
  364. -----------
  365.  
  366. Please rate DateText.mcc and MCC-Install. To do so, send an email to
  367. aminet-server@wuarchive.wustl.edu with the following content:
  368.  
  369. RATE dev/mui/MCC-Install.lha <num>
  370. RATE dev/mui/MCC_DateText.lha <num>
  371.  
  372. where <num> is a mark from 0..10 with 10 being the best.
  373. You can rate several programs in one mail.
  374.  
  375. Thank you!
  376.  
  377.  
  378.  
  379. Software
  380. --------
  381.  
  382. The following software products use DateText.mcc:
  383.  
  384.  
  385.  
  386.  
  387.                       This is a custom class of the
  388.  
  389.  
  390.                         MUI - MagicUserInterface
  391.  
  392.                  Copyright © 1993-1997 by Stefan Stuntz
  393.  
  394.  
  395. MUI is a system to generate and maintain graphical user interfaces. With
  396. the  aid  of  a  preferences program, the user of an application has the
  397. ability to customize the outfit according to his personal taste.
  398.  
  399. MUI is distributed as shareware. To obtain a complete package containing
  400. lots of examples and more information about registration please look for
  401. a  file  called  "muiXXusr.lha"  (XX means the latest version number) on
  402. your local bulletin boards or on public domain disks.
  403.  
  404.           If you want to register directly, feel free to send
  405.  
  406.  
  407.                          DM 30.-  or  US$ 20.-
  408.  
  409.                                   to
  410.  
  411.                              Stefan Stuntz
  412.                         Eduard-Spranger-Straße 7
  413.                              80935 München
  414.                                 GERMANY
  415.  
  416.  
  417.              Support and online registration are available at
  418.  
  419.                           http://www.sasg.com/
  420.  
  421.  
  422.  
  423.                  This product is based on or uses parts of
  424.  
  425.                      MagicWB - The Workbench Enhancer
  426.                      --------------------------------
  427.  
  428.                  Copyright © 1992-1997, Martin Huttenloher
  429.  
  430. If  you  use  and like this product you should very much consider to take a
  431. look  at  MagicWB,  which  is the authentic source of the style, colors and
  432. design  elements  contained  in  this  package.   It  features  hundreds of
  433. original  icons,  patterns, image-drawers,  dock-brushes and some specially
  434. designed  high-quality  fonts  to  improve the comfort & legibility of your
  435. daily Workbench session.
  436.  
  437. What  is  MagicWB?   MagicWB  is  a full replacement for the Graphical User
  438. Interface  of the Workbench and has become the standard visual interface on
  439. the  Amiga.  Over the last years MagicWB has received various merits and an
  440. overwhelming  response from Amiga magazines and users worldwide proclaiming
  441. it  "a  must  for  all  Amiga  users".   Even  commercial  applications are
  442. supporting the multi-colored look & style of MagicWB.
  443.  
  444. Get yourself the latest version of MagicWB and see for yourself the wonders
  445. it  can  do by automatically transforming your old and dull Amiga Workbench
  446. into  an impressive workstation environment that will be the envy of all PC
  447. Windows  and  Mac users.  Update yourself to the state-of-the-art workbench
  448. standard  everyone uses on the Amiga!  It is also your key to enjoy the new
  449. look & feel of many applications and other MWB add-ons and extensions.
  450.  
  451. MagicWB  is  distributed as shareware.  Get yourself the latest FREE PUBLIC
  452. RELEASE of MagicWB now:  It is called
  453.  
  454.                              ----------------
  455.                               MagicWB21p.lha
  456.                              ----------------
  457.  
  458. and  can  be found everywhere on Aminet (or your local BBS or public domain
  459. series).   Install it and witness the instant magic it performs on your old
  460. Amiga  Workbench.   Also  included  is the latest SASG registration program
  461. with which you can order and get the full registered version of MagicWB.
  462.  
  463.              If you want to order directly, feel free to send
  464.  
  465.                   DM 30.- or US$ 20.- (cash, no checks!)
  466.  
  467.                                     to
  468.  
  469.                             Martin Huttenloher
  470.                              Am Hochstraess 4
  471.                                D-89081 Ulm
  472.                                  Germany
  473.  
  474. You  may  also  choose  to visit the official MagicWB homepage on the world
  475. wide  web.   There you can find the latest news & support and even register
  476. your  MagicWB  online  (which is much more comfortable and faster). You can
  477. even  benefit  from  various  special offers & discounts for MagicWB if you
  478. order through our website!  Come and visit MagicWB at:
  479.  
  480.                           ----------------------
  481.                            http://www.sasg.com/
  482.                           ----------------------
  483.  
  484.               Save 20% by using the discounts on our website!
  485.  
  486.            Ordering online also saves you a lot of time and work!
  487.  
  488.  
  489.  
  490. WrapGuide is Copyright 1994-1995 Udo Schuermann
  491. All rights reserved
  492.